home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / wildcat / todaybbs.zip / TODAYBBS.DOC < prev    next >
Text File  |  1992-11-06  |  14KB  |  314 lines
  1.                                 TODAYBBS
  2.                             by Michael Conley
  3.  
  4.                           Release 3.06 11/06/92
  5.  
  6.                       Requires BRUN40.EXE in the path
  7.  
  8. Now requires "BDAYPREP.EXE" ... a separate program to read your
  9. BBS user birthday data and prepare it for TODAYBBS.  The BDAYPREP
  10. program is supplied in a separate ZIP file, and is available from 
  11. the same BBS where you downloaded TODAYBBS.  The reason for
  12. separating these programs is that TODAYBBS is becoming a more
  13. independent program, with support being added for a variety of
  14. BBS programs.  BDAYPREP is Wildcat!-specific.
  15.  
  16. This  program determines the current date, then reads data  files 
  17. containing historical facts and produces daily files of interesting 
  18. information about the current date.  It is intended for use in  a 
  19. BBS  system  where the file can be created as a part of  a  daily 
  20. maintenance routine.   When used in conjunction with the BDAYPREP
  21. program, the program will optionally incorporate users' birthdays
  22. into the display files it produces.
  23.  
  24. IMPORTANT:  TODAYBBS requires the use of BRUN40.EXE, which is the
  25. runtime module for QuickBasic.  It's readily available on BBS systems
  26. throughout the country.  If you have trouble locating it, call me.
  27.  
  28. Bruce Goldman is now producing excellent TODAY.nnn data files which
  29. are compatible with TODAYBBS, as well as some other programs such as
  30. NEWDAY/PC.  These files are widely available in ZIP format, with each
  31. file containing two months worth of material.  The current series as of
  32. this document is series 907, with files named:  DAY907-1.ZIP, 
  33. DAY907-2.ZIP, etc through DAY907-6.ZIP.  Bruce has agreed to distribute 
  34. these files through the Charlatan's Cabin. They will be available to ALL 
  35. callers on the first call... (213) 654-7337.
  36.  
  37. ==============================================================================
  38. NEW FEATURES/CHANGES:
  39.  
  40. Version 3.06 fixes a bug in which certain combinations of categories
  41. would not produce the correct output.
  42.  
  43. Version 3.05 fixes a bug discovered when the data files became larger
  44. than originally envisioned ...
  45.  
  46. Version 3.04 now determines whether your data files are in ascending
  47. or descending sequence by year.  If they are ascending, such as the
  48. newer files by Bruce Goldman, TODAYBBS will reverse the sequence,
  49. so that the newest data is presented first in each category.  After
  50. several conversations, it was decided this approach is desirable for
  51. online use.  If you'd prefer to have the older dates first, you may
  52. either continue to use version 3.03, or let me know and I'll make it
  53. a configuration switch.
  54.  
  55. Version 3.03 fixes a moderately embarrassing leap year bug!
  56.  
  57. Beginning with version 3.02, TDHEADER.DAT and TDTAIL.DAT header and tag
  58. files can now include color codes for the appropriate bulletin board
  59. software you're running.  They are no longer 'forced' into any particular
  60. color, so if you DON'T include color codes, these files will be whatever
  61. color the previous line was.  Therefore we recommend putting in at least
  62. ONE color code at the start of each file if you use them.
  63.  
  64. Version 3.xx can now be run with various BBS software packages.  If you
  65. wish to include user birthdays, you'll need to run the appropriate extraction
  66. program to build TODAY.BIR in your \TODAY\ directory.  
  67.  
  68. In order for TODAYBBS to report User Birthdays, you'll need BDAYPREP, a 
  69. separate ZIP file which extracts this data from your BBS database and
  70. makes a file compatible with the TODAYBBS format.
  71.  
  72. NOTE ON UPGRADING:
  73.  
  74. If you are already running a version of TODAYBBS prior to 3.00 and are 
  75. converting to the new version, you MUST remove your old configuration file,
  76. because the format has changed.  In its place, a new TODAYBBS.CFG file 
  77. contains all of the control parameters for the program.  A sample is 
  78. included with this ZIP file, and is explained below.
  79.  
  80. ==============================================================================
  81. SETTING UP:
  82.  
  83. The only elements that need to be set up to operate this  program 
  84. are  the  TODAY.LCL file and the TODAYBBS.CFG  file.  
  85.  
  86. You may also add optional "header" and "footer" files to customize
  87. your display.  These will be included before and after the display
  88. of the daily data in the output files.  
  89.  
  90. They are named  "TDHEADER.DAT" and "TDTAIL.DAT" and are plain ASCII.
  91. If they are not found, they will be ignored.  Samples are included
  92. with this ZIP file to give you some ideas.  Incidentally, if Wildcat!
  93. display control characters are included, such as the ^U^N (User Name)
  94. function, they will be correctly displayed with the output file is
  95. viewed by Wildcat!  See your Wildcat! documentation for details on 
  96. using these command sequences in display files.
  97.  
  98. The TODAYBBS.CFG file must be located in the currently logged directory 
  99. whenever TODAYBBS is executed.   The first seven lines of the file define 
  100. the operating parameters,  and the  FORMAT MUST BE FOLLOWED EXACTLY.  
  101. A couple samples of this file are shown below:
  102.  
  103. When editing TODAYBBS.CFG, be sure to use an editor which will NOT include 
  104. any special formatting characters, as some word processing programs may do.
  105.  
  106. C:\TODAY\
  107. Charlatan's Cabin BBS
  108. BDHIRSU
  109. C:\WC30\DISP\HELLO9.BBS
  110. CODE
  111. ;
  112. ;Line 1 is the full drive and path name where the "TODAY.xxx" files are kept.
  113. ;       The trailing BACKSLASH is an essential part of the path name.
  114. ;
  115. ;Line 2 is the name of the BBS as you would like it to appear in the output.
  116. ;
  117. ;Line 3 indicates which categories you would like to include in the output
  118. ;       file.  The categories are defined as follows:
  119. ;
  120. ;          B = birthdays of important public figures.
  121. ;          D = deaths of important public figures.
  122. ;          H = holidays.
  123. ;          I = religious observances.
  124. ;          R = reminders of important annual events.
  125. ;          S = events on this day in history
  126. ;          U = users' birthdays (without the year!) (You'll need to 
  127. ;              run a BDAYPREP program designed for your BBS system.)
  128. ;
  129. ;Line 4 is the full drive and pathname for the program's first output file.  
  130. ;       If used with WILDCAT! we suggest using  C:\CAT\HELLO9.BBS  
  131. ;    (substituting the appropriate path name if different) so that 
  132. ;    the file is displayed automatically at the end of your signon 
  133. ;    sequence.
  134. ;
  135. ;Line 5 should contain the word CODE if you want TODAYBBS to output
  136. ;       Wildcat! version 3.x @-code colors in your .BBS display file.
  137. ;        
  138. ;       If used with WILDCAT! 2.x, line 5 should contain the filename
  139. ;       of your ANSI  .SCR format file.  ANSI codes will automatically
  140. ;       be inserted in the .SCR file and NO color codes will be inserted 
  141. ;       in the .BBS file.  Here's a typical configuration file for Wildcat!
  142. ;       version 2.x:
  143. ;
  144. ;                       C:\TODAY\
  145. ;                       Charlatan's Cabin BBS
  146. ;                       BDHIRSU
  147. ;                       C:\WC\DISPLAY\HELLO9.BBS
  148. ;                       C:\WC\DISPLAY\HELLO9.SCR
  149. ;                       
  150. ;       Note that Wildcat! 3.x can use ONE output file for both MONO and
  151. ;       COLOR (ANSI capable) users.  Automatic color codes in the .BBS file
  152. ;       will be masked for non-color users, and converted for those who have
  153. ;       enabled COLOR in their user profiles.
  154. ;
  155. ;       If you don't want ONLY an ASCII file with NO color codes, place the
  156. ;       word "NONE" on line 5.
  157. ;
  158. ;IMPORTANT:  All lines must be included in the file. Obviously certain
  159. ;          combinations will not utilize all of the lines, but they are
  160. ;         read by the program and tested before the program creates the
  161. ;         output file and must conform to the above specifications even
  162. ;         if not used!  The notes after the last line are not required
  163. ;         and may be deleted, but they will not cause a problem.
  164. ;
  165. ;THIS FILE must reside in the currently logged directory when TODAYBBS is run.
  166. ;
  167. ==============================================================================
  168. THE TODAY.LCL FILE:
  169.  
  170. To customize your display with information of particular interest to your
  171. BBS or immediate area, TODAYBBS will scan for the presence of a file
  172. called "TODAY.LCL" and include appropriate lines from it if it's found.
  173.  
  174. Here's how the data format for all of the files works:
  175.  
  176.  
  177. Column 1:
  178.     The record type, which can be a B for birthdays,
  179.     D for deaths, H for holidays, I for religious events,
  180.     S for special dates in history or R for reminders.
  181.     An asterisk (*) in this column denotes a remark.
  182.  
  183. Cols 2-5:
  184.     Month and day as MMDD with leading zeros.  Zeros
  185.     for the day cause ALL days of the month to match
  186.     when being scanned.  For example 0400 would match
  187.     every day of April.
  188.  
  189. Cols 6-9:
  190.     The full year of the event as four digits.
  191.     May be left blank.  For REMINDERS ONLY, this column
  192.     may contain the ending value of a range of dates, 
  193.     for example:  R10021020 would issue a reminder every
  194.     day between October 2nd and October 20th.  Note that
  195.     the BEGINNING or ENDING dates don't have to be within
  196.     the current month, but if they're NOT, then they must
  197.     be included in all applicable monthly files, since only
  198.     ONE file is read based upon the system date.
  199.  
  200. Column 10:
  201.     A special processing flag.  Values may be:
  202.  
  203.     BLANK for no special processing.
  204.  
  205.     C to continue a message from the previous line.
  206.  
  207.     Note, that you MUST repeat the date fields.
  208.  
  209.     DAY-OF-WEEK DIGIT where 1=Sunday ... 7=Saturday
  210.     This will cause the message to display only if the
  211.     date falls on a certain day of the week.  Look in
  212.     the November file for voting day examples.
  213.  
  214. Cols 11-68
  215.     The message to display for this date. If entry is
  216.     longer, use the 'C' processing flag for proper handling.
  217.     The program will attempt to provide word wrap for
  218.     longer entries, but the algorithm is a simple one
  219.     and may not produce ideal results.
  220.  
  221.                        --EXAMPLES--
  222.  
  223. *mmddyyyy Birthdays
  224. *-------- ------------------------------------------------------------
  225. B09011875 Edgar Rice Burroughs, novelist, Ah-ee-ah-ee-ah!
  226. B09021838 Queen Liliuokalani (last queen of Hawaii).
  227. B09021952 Jimmy Connors, tennis brat
  228.  
  229. *mmddyyyy Deaths
  230. *-------- ------------------------------------------------------------
  231. D01131822 Friday the thirteenth monster dies.
  232.  
  233. *mmddyyyy Holidays
  234. *-------- ------------------------------------------------------------
  235. H0901    2Labor Day, a legal Holiday
  236.  
  237. *mmddyyyy Religious events
  238. *-------- ------------------------------------------------------------
  239. I0922     St. Swithen's Day. (probably not right ... sorry!)
  240.  
  241.  
  242. *mmddyyyy Special events
  243. *-------- ------------------------------------------------------------
  244. S09011939 Germany invades Poland, starts World War II.
  245. S09011952 Sutro Baths purchased by George Whitney.
  246. S09021620 The Mayflower sets sail from Plymouth with
  247. S09021620C102 Pilgrims.
  248.  
  249. *mmddyyyy Reminders
  250. *-------- ------------------------------------------------------------
  251. R04010410 Pay the mortgage!
  252. R0401     Taxes due in two weeks.
  253. R0415     Last day to pay taxes!
  254.  
  255. Because it's a reminder, the first line would be displayed throughout
  256. the indicated range, from 04/01 to 04/10.  This special processing
  257. works ONLY with reminders.
  258.  
  259. ==============================================================================
  260. TESTING:
  261.  
  262. To test the program, simply type TODAYBBS<enter> and the output
  263. file you have named in the TODAYBBS.CFG file will be created or
  264. overwritten if it already exists.
  265.  
  266. You may wish to test various dates.  For convenience, TODAYBBS 
  267. will accept dates from the command line.  Since the year is not
  268. used, enter the date as 4 digits in the form:  MMDD.  Leading
  269. and internal zeros must be used, e.g., TODAYBBS 0307<enter>
  270. will produce a file from the information located for March 7.
  271.  
  272. ==============================================================================
  273. OPERATION:
  274.  
  275. If your BBS has a provision for automatic daily maintenance, such
  276. as the WILDCAT! program by Mustang Software, include the following
  277. line(s) in the maintenance batch file, and schedule it to run as
  278. soon as possible after midnight:
  279.  
  280. CD C:\WC30\DATA
  281. BDAYPREP C:\TODAY\
  282. CD C:\WC30
  283. TODAYBBS      
  284.  
  285. This sequence should be edited to suit your system, of course.  We're
  286. assuming in this example that you're running Wildcat! version 3.0, and 
  287. that your ALLUSERS.DAT file is in a directory named \wc\data.  First,
  288. we change to that directory, and run BDAYPREP.  The command line instructs
  289. BDAYPREP to place its output file (TODAY.BIR) in your C:\TODAY\ directory
  290. along with your other TODAY data files.
  291.  
  292. Next, we change to the directory where TODAYBBS.EXE and TODAYBBS.CFG are
  293. located together.  Run TODAYBBS, and it will read its configuration file 
  294. and follow the instructions you've set up.
  295.  
  296. PROBLEMS, QUESTIONS, SUGGESTIONS:
  297. =================================
  298. TODAYBBS is public domain.  I don't seek or accept any registration fees for 
  299. this or any of my other public domain utility programs, including those for
  300. Wildcat! BBS systems.  If you're interested in making a charitable contribu-
  301. tion to express your appreciation, please read the enclosed file SHARE for
  302. my thoughts on the subject.
  303.  
  304. I welcome suggestions, and will try to help (no guarantees) if there are
  305. problems.  You may contact me at The Charlatan's Cabin BBS  (213) 654-7337, 
  306. or via CompuServe (70250,220).
  307.  
  308. If you're a registered Wildcat! SysOp, please leave me a private comment on
  309. the BBS including your Wildcat! registration number, and I'll upgrade you to
  310. member level.
  311.  
  312. ============================================================================
  313.  
  314.